fix(logging): misleading "settings failed" message #7240
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem:
Misleading log message when a setting returns `null`, even if the caller
specified `defaultValue`:
[error] Settings (amazonQ): failed to read "workspaceIndexCacheDirPath":
Unexpected type cast: got object, expected primitive String
`cast()` considers `null` to be "object" type, which is misleading. If
the caller passed a `defaultValue`, they have intentionally opted-in to
ignoring this situation, and *don't* want this kind of log message.
Solution:
If a setting returns `null|undefined`, skip `cast()` and return
`defaultValue` immediately. Don't log an error message.
|
justinmk3
commented
May 6, 2025
| const value = this.#config.get(key, defaultValue) | ||
|
|
||
| if (defaultValue !== undefined && (value === undefined || value === null)) { | ||
| return defaultValue |
Contributor
Author
There was a problem hiding this comment.
test coverage:
jpinkney-aws
approved these changes
May 6, 2025
Hweinstock
approved these changes
May 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Misleading log message when a setting returns
null, even if the caller specifieddefaultValue:cast()considersnullto be "object" type, which is misleading. If the caller passed adefaultValue, they have intentionally opted-in to ignoring this situation, and don't want this kind of log message.Solution
If a setting returns
null|undefined, skipcast()and returndefaultValueimmediately. Don't log an error message.feature/xbranches will not be squash-merged at release time.